Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: pass strikethrough markdown for hint message on field #5727

Merged
merged 1 commit into from
Sep 10, 2021
Merged

feat: pass strikethrough markdown for hint message on field #5727

merged 1 commit into from
Sep 10, 2021

Conversation

JonasMatos0
Copy link
Contributor

Summary

This adds the option to include strikethrough HTML in the hint message on a field. Closes #5717
The issue creator requested support for strikethrough Markdown

Test plan

Please guide me to the testing details if any for this modification. Thanks in advance.

Checklist

Please add a x inside each checkbox:

  • I have read the contribution guidelines.
  • Code is formatted via running yarn format.
  • Tests are passing via running yarn test.
  • The status checks are successful (continuous integration). Those can be seen below.

A picture of a cute animal (not mandatory but encouraged)

@JonasMatos0 JonasMatos0 requested a review from a team August 19, 2021 16:18
@erezrokah erezrokah added the type: feature code contributing to the implementation of a feature and/or user facing functionality label Aug 19, 2021
erezrokah
erezrokah suggested changes Aug 20, 2021
View reviewed changes
Copy link
Contributor

@erezrokah erezrokah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @JonasMatos0, I added 2 comments.

Please note that even with my suggestion I couldn't get neither ~strikethrough~ nor ~~strikethrough~~ to work.

packages/netlify-cms-core/src/components/Editor/EditorControlPane/EditorControl.js Outdated Show resolved Hide resolved
packages/netlify-cms-core/src/components/Editor/EditorControlPane/EditorControl.js Outdated Show resolved Hide resolved
@erezrokah
Copy link
Contributor

Hi @JonasMatos0, can you share a sample config.yml where you got the strikethrough to work?

@JonasMatos0
Copy link
Contributor Author

JonasMatos0 commented Aug 27, 2021 •
edited
Loading

Hi @JonasMatos0, can you share a sample config.yml where you got the strikethrough to work?

Hey, @erezrokah . I noticed latest remark-gfm version wasn't working as expected.
Reduced version to tag 1.0.0 and it worked fine.

Base test is add to any config.yml hint the strikethrough mark, ie:
FROM: - { label: 'Text', name: 'text', widget: 'text', hint: 'Plain text, not markdown' }
TO: - { label: 'Text', name: 'text', widget: 'text', hint: 'Plain text, not ~markdown~' }
OR: - { label: 'Text', name: 'text', widget: 'text', hint: 'Plain text, not ~~markdown~~' }

Tunning the project and validating if it's working as expected, replacing the strikethrough symbols with the del tag.
If you have any other suggestions, please let me know.

erezrokah
erezrokah approved these changes Sep 10, 2021
View reviewed changes
Copy link
Contributor

@erezrokah erezrokah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for digging into this @JonasMatos0, sorry for the late approval.

@erezrokah erezrokah merged commit 27f0448 into decaporg:master Sep 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erezrokah erezrokah erezrokah approved these changes

Assignees
No one assigned
Labels
type: feature code contributing to the implementation of a feature and/or user facing functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support strikethrough markdown in widget hint text
2 participants
@JonasMatos0 @erezrokah